docs(self-hosted): use new taskbroker config format in scaling examples#18550
Merged
aldy505 merged 2 commits intoJun 25, 2026
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| TASKBROKER_KAFKA_CLUSTERS__DEFAULT__ADDRESS: "kafka:9092" | ||
| TASKBROKER_DB_PATH: "/opt/sqlite/taskbroker-activations.sqlite" | ||
| TASKBROKER_STATSD_ADDR: ${STATSD_ADDR:-127.0.0.1:8125} | ||
| command: /opt/taskbroker -c /etc/taskbroker/config.yml |
Contributor
There was a problem hiding this comment.
Bug: The documentation for scaling brokers is missing instructions to create the taskbroker/config.yml file, which will cause container startup failures for the taskbroker-beta and taskbroker-charlie services.
Severity: HIGH
Suggested Fix
Add a section that instructs users on how to create the taskbroker/config.yml file, including its necessary content. This should be similar to the instructions already provided for taskbroker/config.ingest.yml in the "Separate Ingest Workers" section.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: develop-docs/self-hosted/tasks.mdx#L77
Potential issue: The documentation for scaling brokers instructs users to configure the
`taskbroker-beta` and `taskbroker-charlie` services to use a configuration file at
`/etc/taskbroker/config.yml`. The services mount a local `./taskbroker` directory to
`/etc/taskbroker`. However, the documentation omits the step of creating the
`taskbroker/config.yml` file. Users following these instructions will encounter
container startup failures because the taskbroker binary is explicitly told to use a
config file that does not exist. This is inconsistent with the "Separate Ingest Workers"
section, which correctly documents the creation of its required configuration file.
Also affects:
develop-docs/self-hosted/tasks.mdx:93
Did we get this right? 👍 / 👎 to inform future reviews.
Member
Author
There was a problem hiding this comment.
wrong, but it's a bit confusing without context, updated
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
aldy505
approved these changes
Jun 25, 2026
aldy505
deleted the
markusunterwaditzer/taskbroker-docs-new-config-format
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrate the taskbroker scaling examples to the new config-file format (
kafka_topics/kafka_clustersvia a mountedconfig.yml), replacing the deprecatedTASKBROKER_KAFKA_*env-var config.The config format migration was announced in self-hosted 26.6.0.